Add website to DESCRIPTION #33

olivroy · 2024-01-16T22:08:35Z

Also rename logo, so that pkgdown recognizes it.

I noticed you have this in .Rbuildignore, you can #' @noRd to prevent the generation of these internal documentation files instead. This may be more robust in case anything changes

# Ignore the non-exported function documentation
^man/add_feature.Rd$
^man/check_data_frame_for_plot.Rd$
^man/cfl_.*\.Rd$
^man/create_.*\.Rd$
^man/fiba_.*\.Rd$
^man/fifa_.*\.Rd$
^man/iihf_.*\.Rd$
^man/mlb_.*\.Rd$
^man/mls_.*\.Rd$
^man/nba_.*\.Rd$
^man/ncaa_.*\.Rd$
^man/nfl_.*\.Rd$
^man/nhl_.*\.Rd$
^man/nwhl_.*\.Rd$
^man/nwsl_.*\.Rd$
^man/itf_.*\.Rd$
^man/premier_.*\.Rd$
^man/wnba_.*\.Rd$
^man/quadratic_formula.Rd$
^man/distance_formula.Rd$
^man/sport_lookup.Rd$
^man/geom_fiba.Rd$
^man/geom_fifa.Rd$
^man/geom_iihf.Rd$
^man/geom_mlb.Rd$
^man/geom_mls.Rd$
^man/geom_nba.Rd$
^man/geom_ncaa_bb.Rd$
^man/geom_ncaa_football.Rd$
^man/geom_ncaa_hockey.Rd$
^man/geom_ncaa_soccer.Rd$
^man/geom_nfl.Rd$
^man/geom_nhl.Rd$
^man/geom_nwhl.Rd$
^man/geom_nwsl.Rd$
^man/geom_premier_league.Rd$
^man/geom_wnba.Rd$
^man/geom_itf.Rd$
^man/geom_ncaa_tennis.Rd$
^man/league_lookup.Rd$

Summary by CodeRabbit

Documentation
- Updated the project URL for better accessibility.
- Enhanced the README with a new badges section, including CRAN version and social media follow options.
- Improved logo display in the documentation.

Signed-off-by: olivroy <[email protected]>

coderabbitai · 2024-01-16T22:08:42Z

Walkthrough

The sportyR package repository has undergone changes to its web presence and documentation. The project's URL now includes a dedicated website in addition to the GitHub repository. The README files have been visually enhanced with a new image and functionally improved with a badges section, offering quick access to package status and social media links.

Changes

File	Change Summary
URL	Updated to include the dedicated website for `sportyR`
README.Rmd	Added a badges section
README.md	Updated logo image and added badge section with CRAN version and Twitter follow badges

Poem

In the code fields where the functions hop, 🐇💻
A new site springs up with a gentle plop,
Badges shine like stars in the night, ✨
Guiding coders to the sportyR light. 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

vercel · 2024-01-16T22:08:46Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
sporty-r	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 16, 2024 10:10pm

coderabbitai

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between af86511 and d38777b.

Files ignored due to path filters (1)

man/figures/logo.png is excluded by: !**/*.png

Files selected for processing (3)

DESCRIPTION (1 hunks)
README.Rmd (2 hunks)
README.md (2 hunks)

Additional comments: 3

DESCRIPTION (1)

38-38: The addition of the official website URL to the DESCRIPTION file is correct and follows standard practices for R packages.

README.Rmd (1)

20-26: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [23-36]

The badges section has been correctly added to the README.Rmd file, providing quick access to the package status and community engagement.

README.md (1)

1-9: > Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [6-19]

The badge section has been successfully added to the README.md file, enhancing the documentation with visual indicators of the package's status.

README.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: olivroy <[email protected]>

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between d38777b and ade8548.

Files selected for processing (1)

README.md (2 hunks)

Files skipped from review as they are similar to previous changes (1)

README.md

codecov · 2024-01-16T22:12:50Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (af86511) 99.90% compared to head (ade8548) 99.90%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #33   +/-   ##
=======================================
  Coverage   99.90%   99.90%           
=======================================
  Files          25       25           
  Lines        8410     8410           
=======================================
  Hits         8402     8402           
  Misses          8        8

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

sweep-ai · 2024-01-16T22:29:46Z

Apply Sweep Rules to your PR?

Apply: All new business logic should have corresponding unit tests.
Apply: Refactor large functions to be more modular.
Apply: Add docstrings to all functions and file headers.

This is an automated message generated by Sweep AI.

rossdrucker

Thanks for the update!

olivroy added 4 commits January 16, 2024 17:02

Add website to DESCRIPTION

46f18a3

Signed-off-by: olivroy <[email protected]>

Rename sportyr-logo-hex.png to logo.png

1d1a676

Signed-off-by: olivroy <[email protected]>

Update README.md

213e0f7

Signed-off-by: olivroy <[email protected]>

Update README.Rmd

d38777b

Signed-off-by: olivroy <[email protected]>

vercel bot deployed to Preview January 16, 2024 22:08 View deployment

coderabbitai bot reviewed Jan 16, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

ade8548

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: olivroy <[email protected]>

vercel bot deployed to Preview January 16, 2024 22:10 View deployment

coderabbitai bot reviewed Jan 16, 2024

View reviewed changes

rossdrucker approved these changes Jan 28, 2024

View reviewed changes

rossdrucker merged commit e10dd84 into sportsdataverse:main Jan 28, 2024
12 checks passed

olivroy deleted the patch-1 branch January 29, 2024 14:06

olivroy mentioned this pull request May 23, 2024

Should use_logo() call or suggest pkgdown::build_favicons()? r-lib/usethis#1995

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add website to DESCRIPTION #33

Add website to DESCRIPTION #33

olivroy commented Jan 16, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 16, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

vercel bot commented Jan 16, 2024 •

edited

Loading

coderabbitai bot left a comment

coderabbitai bot left a comment

codecov bot commented Jan 16, 2024 •

edited

Loading

sweep-ai bot commented Jan 16, 2024

rossdrucker left a comment

Add website to DESCRIPTION #33

Add website to DESCRIPTION #33

Conversation

olivroy commented Jan 16, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Jan 16, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

vercel bot commented Jan 16, 2024 • edited Loading

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Jan 16, 2024 • edited Loading

Codecov Report

sweep-ai bot commented Jan 16, 2024

Apply Sweep Rules to your PR?

rossdrucker left a comment

Choose a reason for hiding this comment

olivroy commented Jan 16, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 16, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

vercel bot commented Jan 16, 2024 •

edited

Loading

codecov bot commented Jan 16, 2024 •

edited

Loading